home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / hscat3s.zip / HSCATS.DOC < prev    next >
Text File  |  1992-04-12  |  10KB  |  223 lines
  1.                                  H S C A T S
  2.                                  Version 3.0
  3.  
  4.                  WILDCAT 3.xx AND HSLINK INTERFACE HELP DOC'S
  5.                  --------------------------------------------
  6.  
  7.    If you have used HsLink, you know it is a powerful file transfer
  8.    protocol that allows you to download and upload at the same time
  9.    when the user selects to download with HsLink, essentially
  10.    doubling your throughput.  HsCats will interface HsLink to Wildcat
  11.    so your users can enjoy this terrific protocol on your Wildcat system.
  12.  
  13.    HsCats has three parts PREHSCUP, PREHSCDN, and AFTHSCDN.
  14.    These are called from the batch protocol file either HSLUP.BAT or
  15.    HSLDN.BAT. Here how it works...pay close attention!
  16.  
  17.    USER DOWNLOAD SESSION:
  18.  
  19.    The user marks off what files they wish to download via Wildcat's file
  20.    marking system. Just as they would with any other protocol. They then
  21.    select to download and are offered the protocol menu screen. They select
  22.    [H] for HsLink and away we go.....
  23.  
  24.    The HSCDN.BAT batch file first calls PREHSCDN.EXE which prompts the
  25.    user for an area to upload to (that they have security for) and writes
  26.    two files...HSCAT.### (Area chosen by user) and HSACESS.### (which is
  27.    the pointer file for areas that they have security to download from).
  28.    It will write this info to the HsLink.Cfg file that you point to on
  29.    the command line.
  30.  
  31.    AFTHSCDN.EXE will then be called in the batch file and read the
  32.    DSZ.LOG and HSCAT.### files and add whatever files where uploaded
  33.    during the download session to the Wildcat database. It then updates the
  34.    user record for files uploaded and extra time alloted. Wildcat will take
  35.    care of updating the user and file database for files that where
  36.    downloaded.
  37.  
  38.    ************************************************************************
  39.    *Special Note*
  40.    At present the internal code in Wildcat prevents me from updating the
  41.    user's upload or download count and kilobytes. This is something for
  42.    which I am not responsible, nor can I change. Wildcat version 3.50 will
  43.    have this problem corrected at which time my utilities will be able to
  44.    update the user record properly.
  45.    ************************************************************************
  46.  
  47.    USER UPLOAD SESSION:
  48.  
  49.    The user selects the area to upload to via Wildcat as normal. Then WC
  50.    will ask for filenames, descriptions, passwords, keywords, and additional
  51.    info as it does for any protocol used. The user then selects [H] HsLink
  52.    from the protocol menu as transfer type to use.
  53.  
  54.    The HSLUP.BAT batch file first calls PREHSCUP.BAT which sets up the
  55.    HsLink.Cfg file for the proper path to the node's ep directory.
  56.  
  57.    HsLink will then run and send whatever files the user has configured
  58.    in the upload transfer to the node's ep directory. At present HsLink
  59.    only allows bidirectional transfers to occur when the user selects
  60.    downloading. If they select uploading it will only allow the upload
  61.    to occur. Hope Sam Smith will add that feature in a future version..
  62.    I have the code to make it work in HsCats should he do so.
  63.  
  64.    In a nut shell...it's kinda like merging HsCats and Wildcat together into
  65.    one package...simply called HsCats.
  66.  
  67.  
  68.                                 SETUP
  69.  
  70.  
  71.    Setting things up is simple, and we'll go through it step by step.
  72.                                                                        
  73.             USE A WORK DIRECTORY FOR YOUR UNARCHIVING OF FILES
  74.  
  75.    Create a new directory to work in.  This keeps things much easier to
  76.    follow along with and clean up after.
  77.  
  78.    Ok, here we go.
  79.  
  80.    1.  Take all the .EXE files from the HsLink archive (HSLxxx.ZIP)
  81.    and put them in any directory that you have your dos environment
  82.    'path' set up for.  Type 'set' at the dos prompt to check.  I set
  83.    everything into a directory called c:\wc\ep and include it in the
  84.    path statement in my autoexec.bat.
  85.  
  86.    2.  Do the same thing with the *.EXE files from this (HSCATSxxx.ZIP)
  87.    archive.  All the files should now be available in the path.
  88.  
  89.    3.  Place the copy of HSLINK.CFG I have included into each of your
  90.    node home directories. IE: c:\wc30\wcwork\node1, c:\wc30\wcwork\node2,
  91.    etc.
  92.  
  93.    4.  In each directory that you put a copy of HSLINK.CFG, run
  94.    HSCONFIG to make changes necessary for your system.  The copy I have
  95.    included is a regular setup and should not require much modification.
  96.    Make changes to this section as follows. Remember to run HSCONFIG from
  97.    the node directory! You should refer to the HsLink Docs for further
  98.    information regarding HsLink's options.
  99.  
  100.  
  101.        A. 'Directory for downloaded files' should be set to your node's
  102.    ep directory.  HSCATS will do all that work for you for each caller
  103.    engaged in a HsLink session. We only need to fill it in the first
  104.    time.
  105.  
  106.    5.  Complete above step for each one of your nodes if you
  107.    are multi-node Wildcat.
  108.  
  109.    7.  Copy the enclosed HSLDN.BAT and HSLUP.BAT batch files to your
  110.    home directory. Then change to the home directory. Edit whatever you
  111.    need to on the batch files I have included for operation on your
  112.    system.
  113.  
  114.    8.  Run Makewild (still in the home directory) and go to the External
  115.    Protocol section. Add HsLink to the external protocol menu as such:
  116.  
  117.    [H]  HsLink  HSLUP.BAT  HSLDN.BAT   Y
  118.  
  119.    * Environment Variables, there are a few you need to set to have
  120.    HsCats operate properly. Make sure you set the following variables
  121.    in each of your cat#.bat files.
  122.  
  123.    IE: Set WCNODEID=(node you are on ie: 1)
  124.        Set WCPORTID=(port you are using on that node ie: 1)
  125.        Set HOMEPATH=(path to home directory ie: C:\WC30\)
  126.        Set NODEPATH=(path to node directory ie: C:\WC30\WCWORK\NODE1\)
  127.  
  128.    * Remember to add the extra backslash at end of directories above.
  129.  
  130.    *************************************************************************
  131.    * I now look for 2 more environment variables for the comm routine.     *
  132.    * They are WCIRQID and WCBASEID respectively. If they are not set in    * 
  133.    * your cat.bat file that starts the node then I default to the settings *
  134.    * in your MakeWild.Dat.                                                 *
  135.    *************************************************************************
  136.  
  137.  
  138.    * HsCats offers file virus scanning via ScanFile.Bat If HsCats
  139.    finds the file "SCANFILE.BAT" it will shell to EMS or DISK before
  140.    adding the file to Wildcat's database. ScanFile.Bat will do it's normal
  141.    job of scanning the file. If the file fails, HsCats will add it to
  142.    the database with the failed scan flag set to Y. It will also subtract
  143.    the file and upload kilobytes from the users record.
  144.  
  145.    Again...as stated above in special note, the code will not work on the
  146.    user's record at present until Wildcat 3.50 is released this part of
  147.    utility will be useless.
  148.  
  149.    At present I have only tested CatScan, which operates properly. Other
  150.    scanners may be used but I can only atest to the fact that CatScan causes
  151.    no problems. If you are going to use another utility in your Scanfile.Bat
  152.    file along with your scanner then follow this simple rule. Change back to
  153.    the Node's directory at the end of the batch file. The following example
  154.    will help you to understand what I mean:
  155.  
  156.    cd\wc30\wcwork\node%wcnodeid%
  157.    catscan %1
  158.    cd\wc30
  159.   { some other utility autodesc, etc. }
  160.    cd\wc30\wcwork\node%wcnodeid%
  161.  
  162.    If you are not running some other utility after your scanner then you
  163.    don't have to worry about changing back to the Node's directory.
  164.  
  165.  
  166.                                ┌──────────────┐
  167.                                │ UPLOAD NOTES │
  168.                                └──────────────┘
  169.  
  170.    Through the use of PREHSCDN.EXE, a single selectable upload area is
  171.    supported, so the user may upload to an area of their choice that they
  172.    have access to normally.  All uploads that occur during any one
  173.    session will go to the area that the user so chooses, they will only
  174.    be allowed to choose areas for which they have security for. This
  175.    means for each HSLINK session they can select the area they want to
  176.    upload too.
  177.  
  178.    Save Upload's to Which Area ("?" for Choices) ?
  179.  
  180.    [1] New Uploads   [26] Sysop Only!
  181.  
  182.    They will only be shown areas for which they have security for in WC!
  183.   
  184.    * Wildcat in its wctext.dat tells the user to start the HsLink transfer
  185.    now! when download is selected. This occurs before the user is asked
  186.    by HsCats which file area to upload to. You can do what I did and use
  187.    your mkwctext and change the prompt # 542 to one that will not cause
  188.    a conflict, such as:
  189.  
  190.  "HsLink & BiModem User's, StandBy to select an upload area! (CTRL-X) aborts!"
  191.  
  192.  
  193.    So there you have it in a nut shell. It is easy to setup and totally
  194.    worth the effort!!!! If you should have any questions please feel
  195.    free to call me and I will help you out. I can be reached at my BBS
  196.    from 8pm till 8:00am (East Coast Time), Which at present is the only
  197.    hours my bbs will be up and running. PLEASE do not call anytime other
  198.    than the hours specified until I get another phone line installed.
  199.    The BBS # is (717)-731-8299 (19,200 V42/Bis) Good Luck and thanks for
  200.    supporting HSCATS, HSLINK & WILDCAT!
  201.  
  202.  
  203.                                                Enjoy!        04/12/92
  204.  
  205.                                 Dale Fedorchik
  206.                              The Cat's Castle BBS
  207.  
  208.  
  209.                                  Warranty
  210.  
  211.  
  212.    This is product is provided "as is" without warranty of any kind. The
  213.    entire risk as to the results and performance of the program is
  214.    assumed by you. Futher more, I the author do not warrant, guarantee,
  215.    or make any representations regarding the use of, or the results of
  216.    the use of the program, and you rely on the program and results
  217.    solely at your own risk. I the author cannot accept responsibility
  218.    for system damage, loss of profit, or any other special, incidental,
  219.    or consequential damages resulting from the use or inability to use
  220.    this product.
  221.  
  222.  
  223.